Skip to content

Simplify docs and rename to BiocCheck Rapid Workflow - #33

Merged
lwaldron merged 2 commits into
mainfrom
simplify-docs
Oct 21, 2026
Merged

lwaldron merged 2 commits into
mainfrom
simplify-docs

Conversation

@lwaldron

@lwaldron lwaldron commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

Documentation cleanup from a review of the repo for simplicity and clarity. No change to what the checks do.

  • Remove workflow_comparison.md. It was a 300-line diff against the old waldronlab workflow and had already drifted from bioccheck.yml; the ADRs record the same decisions.
  • Fix the two help-text links in the workflow generator that pointed at a non-existent anchor in bioccheck_usage.md.
  • Move the versioning strategy and release checklist to technical_notes.md. The checklist named a README table that doesn't exist; it now lists the three real locations.
  • Drop pages: write / id-token: write from canary.yml, which never enables pkgdown.
  • Name the reusable workflow "BiocCheck Rapid Workflow" consistently (it had three names across the workflow file and docs). The caller template keeps name: Bioconductor CI.
  • Add badge instructions to the README Quick Start, and small cleanups in bioccheck.yml comments and the usage guide.

Two runtime changes (conditional installs, single-element matrix removal) are deferred to #34.


🤖 Generated with Claude Code

- Remove stale workflow_comparison.md (diff against old waldronlab workflow)
- Fix broken anchors in the workflow generator help text
- Move versioning/release checklist to technical_notes.md; fix locations
- Drop unused pages/id-token permissions from canary.yml
- Add badge instructions to README Quick Start

Co-Authored-By: Claude <noreply@anthropic.com>
@lwaldron lwaldron changed the title Simplify docs and rename to Rapid BiocCheck Workflow Simplify docs and rename to BiocCheck Rapid Workflow Oct 21, 2026
@lwaldron
lwaldron merged commit 11488de into main Oct 21, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant